home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audio / ALgetfillable.z / ALgetfillable
Encoding:
Text File  |  2002-10-03  |  3.6 KB  |  67 lines
  1.  
  2.  
  3.  
  4. AAAALLLLggggeeeettttffffiiiillllllllaaaabbbblllleeee((((3333ddddmmmm))))                                          AAAALLLLggggeeeettttffffiiiillllllllaaaabbbblllleeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ALgetfillable - (obsolete) report the number of unfilled sample locations
  10.      in an audio port
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      lllloooonnnngggg AAAALLLLggggeeeettttffffiiiillllllllaaaabbbblllleeee((((AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt))))
  16.  
  17. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  18.      _p_o_r_t   expects the audio port you want to query.  This structure is the
  19.             returned value of the AAAALLLLooooppppeeeennnnppppoooorrrrtttt((((3333ddddmmmm)))) call.
  20.  
  21. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.      AAAALLLLggggeeeettttffffiiiillllllllaaaabbbblllleeee is obsolete and is provided for backward compatibility. The
  23.      preferred function is aaaallllGGGGeeeettttFFFFiiiillllllllaaaabbbblllleeee((((3333ddddmmmm)))), which returns the number of
  24.      fillable sample frames in a port.
  25.  
  26.      AAAALLLLggggeeeettttffffiiiillllllllaaaabbbblllleeee((((3333ddddmmmm)))) returns the number of sample locations in an audio
  27.      port that have not yet been filled.  How you interpret this number
  28.      depends on whether _p_o_r_t is an input port or an output port.
  29.  
  30.      For an input port, the return value is a count of spaces that the device
  31.      can fill up before the port overflows, causing a loss of samples.
  32.  
  33.      For an output port, the return value is the greatest number of samples
  34.      that can be written to the port without blocking (i.e. waiting for more
  35.      samples to be played).
  36.  
  37.      Because the port continues to empty or fill, the number returned by
  38.      AAAALLLLggggeeeettttffffiiiillllllllaaaabbbblllleeee((((3333ddddmmmm)))) is an instantaneous measurement of the number of
  39.      fillable locations.  For input ports, this number will decrease over time
  40.      as new samples arrive.  For output, ports this number will increase as
  41.      samples are played.
  42.  
  43.      In order to insure the best possible performance, AAAALLLLggggeeeettttffffiiiillllllllaaaabbbblllleeee((((3333ddddmmmm))))
  44.      performs no verification of _p_o_r_t. You should make certain that _p_o_r_t is a
  45.      valid AAAALLLLppppoooorrrrtttt structure before passing it as a parameter to
  46.      AAAALLLLggggeeeettttffffiiiillllllllaaaabbbblllleeee((((3333ddddmmmm)))).
  47.  
  48. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  49.      Upon successful completion, AAAALLLLggggeeeettttffffiiiillllllllaaaabbbblllleeee((((3333ddddmmmm)))) returns a non-negative
  50.      number.
  51.  
  52. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  53.      ALopenport(3dm), ALgetfilled(3dm)
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.